Implemented VS API for toggling of C++20 modules and STL module build #2130

nickclark2016 · 2023-08-30T01:03:44Z

What does this PR do?

Closes #2105 by introducing 2 new APIs. Introduces buildstlmodules and enablemodules to the vsXXXX exporters. buildstlmodules controls if the STL modules should be built for C++23 and enablemodules controls if modules are to be built. This API does not affect if module files are added to the project or not.

Example Usage:

buildstlmodules 'Off' -- affects VS2022 only
enablemodules 'On' -- affects VS2019 and VS2022

How does this PR change Premake's behavior?

Does not affect existing scripts.

Anything else we should know?

N/A

Did you check all the boxes?

Focus on a single fix or feature; remove any unrelated formatting or code changes
Add unit tests showing fix or feature works; all tests pass
Mention any related issues (put closes #XXXX in comment to auto-close issue when PR is merged)
Follow our coding conventions
Minimize the number of commits
Align documentation to your changes

You can now support Premake on our OpenCollective. Your contributions help us spend more time responding to requests like these!

website/docs/buildstlmodules.md

website/docs/enablemodules.md

Jarod42 · 2023-08-30T14:43:29Z

modules/vstudio/vs2010_vcxproj.lua

+
+	function m.buildStlModules(cfg)
+		if _ACTION >= "vs2022" then
+			if cfg.buildstlmodules then


~~Would it make sense to have this one activated, and not the other? (to emit warning for strange config).~~

In my opinion, it makes no sense to have this activated wtihout the other, but I don't believe we do this kind of sanity checking elsewhere.

vulcan-dev · 2023-09-02T12:42:37Z

I appreciate you adding this, makes it easier for a lot of us to experiment and or use it.
However, I do have a question regarding ScanSourceForModuleDependencies, I've had to enable that for anything to really work, otherwise I can't import things from the standard library or Windows.h. Do you think you could possibly add that if you have free time? If not, then I think I could add it soon because I see how you've added the others.

nickclark2016 · 2023-09-02T20:16:10Z

I appreciate you adding this, makes it easier for a lot of us to experiment and or use it. However, I do have a question regarding ScanSourceForModuleDependencies, I've had to enable that for anything to really work, otherwise I can't import things from the standard library or Windows.h. Do you think you could possibly add that if you have free time? If not, then I think I could add it soon because I see how you've added the others.

Does scanformoduledependencies fit your needs? It is an existing API.

nickclark2016 · 2023-09-09T23:13:58Z

I appreciate you adding this, makes it easier for a lot of us to experiment and or use it. However, I do have a question regarding ScanSourceForModuleDependencies, I've had to enable that for anything to really work, otherwise I can't import things from the standard library or Windows.h. Do you think you could possibly add that if you have free time? If not, then I think I could add it soon because I see how you've added the others.

Does scanformoduledependencies fit your needs? It is an existing API.

Bumping this @vulcan-dev

vulcan-dev · 2023-09-09T23:22:02Z

I appreciate you adding this, makes it easier for a lot of us to experiment and or use it. However, I do have a question regarding ScanSourceForModuleDependencies, I've had to enable that for anything to really work, otherwise I can't import things from the standard library or Windows.h. Do you think you could possibly add that if you have free time? If not, then I think I could add it soon because I see how you've added the others.

Does scanformoduledependencies fit your needs? It is an existing API.

Bumping this @vulcan-dev

I apologise, I must have had to go when I was responding last time.

It does not, I remember having issues regarding modules, and I had to enable the other option. In my temporary fix, I have it enabled as well and that's what worked for me.

nickclark2016 · 2023-09-09T23:30:01Z

I appreciate you adding this, makes it easier for a lot of us to experiment and or use it. However, I do have a question regarding ScanSourceForModuleDependencies, I've had to enable that for anything to really work, otherwise I can't import things from the standard library or Windows.h. Do you think you could possibly add that if you have free time? If not, then I think I could add it soon because I see how you've added the others.

Does scanformoduledependencies fit your needs? It is an existing API.

Bumping this @vulcan-dev

I apologise, I must have had to go when I was responding last time.

It does not, I remember having issues regarding modules, and I had to enable the other option. In my temporary fix, I have it enabled as well and that's what worked for me.

So in the fix from this code, the scanformoduledependencies does not work? That's weird, since that targets the ScanSourceForModuleDependencies property.

vulcan-dev · 2023-09-10T00:13:48Z

I appreciate you adding this, makes it easier for a lot of us to experiment and or use it. However, I do have a question regarding ScanSourceForModuleDependencies, I've had to enable that for anything to really work, otherwise I can't import things from the standard library or Windows.h. Do you think you could possibly add that if you have free time? If not, then I think I could add it soon because I see how you've added the others.

Does scanformoduledependencies fit your needs? It is an existing API.

Bumping this @vulcan-dev

I apologise, I must have had to go when I was responding last time.

It does not, I remember having issues regarding modules, and I had to enable the other option. In my temporary fix, I have it enabled as well and that's what worked for me.

So in the fix from this code, the scanformoduledependencies does not work? That's weird, since that targets the ScanSourceForModuleDependencies property.

If that's the case, then it would work. I thought it was a different option, but I thought wrong. My apologies

nickclark2016 · 2023-09-10T00:21:31Z

If that doesn't work when we merge this in, open up a bug and I'll look.

samsinsane · 2023-09-18T04:39:41Z

modules/vstudio/_preload.lua

+		kind = "string",
+		allowed = {
+			"On",
+			"Off"
+		}


Using the boolean type would probably be better.

I thought about using those, but there are also plenty of spots in the code where "Off" and "On" are used in place of a boolean value. Should we start just using boolean instead? If so, that's an easy fix.

The inputs for boolean are more flexible:

premake-core/src/base/api.lua

Lines 762 to 787 in 561f9a9

local mapping = {

["false"] = false,

["no"] = false,

["off"] = false,

["on"] = true,

["true"] = true,

["yes"] = true,

}

if type(value) == "string" then

value = mapping[value:lower()]

if value == nil then

error { msg="expected boolean; got " .. value }

end

return value

end

if type(value) == "boolean" then

return value

end

if type(value) == "number" then

return (value ~= 0)

end

return (value ~= nil)

From memory there are issues when using this with look up tables, which is how the toolsets work. So, it's up to you whether you think it's a good idea or not.

samsinsane · 2023-09-18T04:39:49Z

modules/vstudio/_preload.lua

+		kind = "string",
+		allowed = {
+			"On",
+			"Off"
+		}


HerrDingenz · 2023-11-21T12:52:05Z

did this got implemented in a new release already?

nickclark2016 · 2023-11-21T12:55:15Z

did this got implemented in a new release already?

No new release has been cut since this. You can either use binaries from a recent GitHub Action, or you could build premake yourself

HerrDingenz · 2023-11-21T12:56:53Z

nevermind - i just noticed it will be in Premake 5.0.0 beta 3

Jarod42 reviewed Aug 30, 2023

View reviewed changes

Implemented VS API for toggling of C++20 modules and STL module build

912aeae

nickclark2016 force-pushed the issues/2105 branch from 4c6588e to 912aeae Compare August 30, 2023 16:41

nickclark2016 requested a review from Jarod42 September 1, 2023 23:46

samsinsane approved these changes Sep 18, 2023

View reviewed changes

Jarod42 approved these changes Sep 23, 2023

View reviewed changes

nickclark2016 merged commit b94b9d7 into premake:master Oct 30, 2023
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implemented VS API for toggling of C++20 modules and STL module build #2130

Implemented VS API for toggling of C++20 modules and STL module build #2130

nickclark2016 commented Aug 30, 2023

Jarod42 Aug 30, 2023 •

edited

Loading

nickclark2016 Aug 30, 2023

Jarod42 Sep 2, 2023

vulcan-dev commented Sep 2, 2023

nickclark2016 commented Sep 2, 2023

nickclark2016 commented Sep 9, 2023

vulcan-dev commented Sep 9, 2023

nickclark2016 commented Sep 9, 2023

vulcan-dev commented Sep 10, 2023

nickclark2016 commented Sep 10, 2023

samsinsane Sep 18, 2023

nickclark2016 Sep 18, 2023

samsinsane Sep 20, 2023

samsinsane Sep 18, 2023

HerrDingenz commented Nov 21, 2023

nickclark2016 commented Nov 21, 2023

HerrDingenz commented Nov 21, 2023

	local mapping = {
	["false"] = false,
	["no"] = false,
	["off"] = false,
	["on"] = true,
	["true"] = true,
	["yes"] = true,
	}

	if type(value) == "string" then
	value = mapping[value:lower()]
	if value == nil then
	error { msg="expected boolean; got " .. value }
	end
	return value
	end

	if type(value) == "boolean" then
	return value
	end

	if type(value) == "number" then
	return (value ~= 0)
	end

	return (value ~= nil)

Implemented VS API for toggling of C++20 modules and STL module build #2130

Implemented VS API for toggling of C++20 modules and STL module build #2130

Conversation

nickclark2016 commented Aug 30, 2023

Jarod42 Aug 30, 2023 • edited Loading

Choose a reason for hiding this comment

nickclark2016 Aug 30, 2023

Choose a reason for hiding this comment

Jarod42 Sep 2, 2023

Choose a reason for hiding this comment

vulcan-dev commented Sep 2, 2023

nickclark2016 commented Sep 2, 2023

nickclark2016 commented Sep 9, 2023

vulcan-dev commented Sep 9, 2023

nickclark2016 commented Sep 9, 2023

vulcan-dev commented Sep 10, 2023

nickclark2016 commented Sep 10, 2023

samsinsane Sep 18, 2023

Choose a reason for hiding this comment

nickclark2016 Sep 18, 2023

Choose a reason for hiding this comment

samsinsane Sep 20, 2023

Choose a reason for hiding this comment

samsinsane Sep 18, 2023

Choose a reason for hiding this comment

HerrDingenz commented Nov 21, 2023

nickclark2016 commented Nov 21, 2023

HerrDingenz commented Nov 21, 2023

Jarod42 Aug 30, 2023 •

edited

Loading